Update executor and observable docs #2594
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2594 +/- ##
=======================================
Coverage 98.72% 98.72%
=======================================
Files 92 92
Lines 4169 4169
=======================================
Hits 4116 4116
Misses 53 53 ☔ View full report in Codecov by Sentry. |
natestemen
approved these changes
Dec 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the docs for the executor and observable to ensure clear warnings to help users with the compatibility.
In #2449 (comment), @natestemen recommended the following changes to the documentation that are addressed by this PR:
These suggestions are independent of code changes. The warnings should highlight what the needs are for our API.
We do mention in the The input function section of the Executors core concept page that type hinting or annotation is required. This should be upgraded to a warning[^directives] and flushed out.
The Using observables in error mitigation techniques section of the Observables core concept page should also have a warning and be flushed out.
License